Skip to content

fix: daily docs scan — CI hard-fails, broken prop names, style fixes - #398

Open
claude[bot] wants to merge 1 commit into
mainfrom
docs/daily-scan-2026-07-21
Open

fix: daily docs scan — CI hard-fails, broken prop names, style fixes#398
claude[bot] wants to merge 1 commit into
mainfrom
docs/daily-scan-2026-07-21

Conversation

@claude

@claude claude Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Requested by Archie McKenzie · Slack thread

Daily automated scan for documentation-quality issues across docs/en-US/, blog/en-US/, devlog/en-US/, and authors/. 18 subagents scanned every subsection in parallel; only high-confidence, mechanical fixes were applied.

Before/After summary

Authors

  • authors/jackie.mdx, authors/default.mdx: Before: missing the required occupation frontmatter field. After: added (Software Engineer, Team).
  • authors/archie.mdx: Before: twitter URL had a stray /photo suffix. After: cleaned to the plain profile URL.

Blog (blog/en-US/)

  • i18n-without-translation-files.mdx: Before: a bare import Video from '@/components/Video' statement in the MDX body — a CI hard-fail. After: removed (the <Video> component is globally available, no import needed).
  • gt-next.mdx: Before: two fenced code blocks missing a language id ( ``` copy and ```.env copy). After: tagged bash and env.
  • ai-chatbot.mdx: Before: ## Deploying to Production used Title Case, inconsistent with every other heading in the file. After: sentence case.
  • multilingual-nextjs-seo.mdx: Before: two untagged code fences, plus a leftover editorial JSX comment left in published prose. After: fences tagged text; comment removed.
  • plurals.mdx: Before: four untagged code fences. After: tagged text.

Devlog (devlog/en-US/)

  • gt-react_v10_15_0.mdx, gt-react_v10_19_0.mdx, react-core-linter_v0_1_0.mdx: Before: bare import Video from '@/components/Video' statements in the MDX body — CI hard-fails. After: removed; the <Video> usages that follow are unaffected since the component is globally available.
  • gt-i18n_v0_1_0.mdx: Before: msg(), mFallback(), gtFallback() linked to placeholder (#) anchors. After: de-linked to plain inline code since no reference page exists yet for this package.
  • gt-next_v6_3_0.mdx, gt-react_v10_18_0.mdx: Before: untagged code fences. After: tagged text.

Docs — CLI

  • cli/quickstart.mdx: Before: no blank line between the ## Quickstart heading and its lead-in paragraph. After: blank line added.

Docs — Python

  • python/reference/functions/extract-variables.mdx: Before: frontmatter description opened with the abbreviation "GT" instead of spelling out the product name on first mention. After: "General Translation".

Docs — React

  • react/guides/configuring.mdx: Before: frontmatter missing the required blank line before the closing ---. After: added.
  • react/nextjs-quickstart.mdx: Before: dev-setup .env.local snippet set the development key into GT_API_KEY (per the Next.js config reference, that variable is production-only); the troubleshooting section used a context prop and code example that doesn't match the library's actual $context prop, plus a "Both X, Y, and Z" grammar slip. After: env var corrected to GT_DEV_API_KEY; prop corrected to $context in prose and code; grammar fixed.
  • react/nextjs-pages-router-quickstart.mdx: Before: same GT_API_KEY/GT_DEV_API_KEY mismatch in its dev-setup snippet. After: corrected.
  • react/reference/lint-rules.mdx: Before: the getGT link in the rules table pointed at the Node SDK's getGT, but the React Core linter's default libs are gt-react/gt-next/gt-react-native, not gt-node. After: repointed to the Next.js getGT reference page, matching how this function is linked elsewhere in the same doc set.

Docs — Platform / Core

  • platform/core/quickstart.mdx: Before: frontmatter description wrapped generaltranslation in backticks (backticks render literally in meta descriptions/llms.txt). After: backticks removed.
  • platform/core/guides/translating-files.mdx: Before: an ungrammatical intro sentence mixing verbs and a noun ("upload, enqueue, status, and download workflows for files"). After: reworded to parse correctly.
  • platform/core/reference/gt-class/constructor.mdx: Before: "enterprise deployments" lowercase in two spots, inconsistent with the canonical casing used on the sibling types reference page. After: capitalized to "Enterprise".

Docs — Platform / Dashboard

  • platform/dashboard/reference/project-settings.mdx: Before: frontmatter missing the required blank lines after the opening and before the closing ---. After: added.
  • platform/dashboard/guides/adding-translation-context.mdx: Before: lowercase German formal "sie" (should always be capitalized as "Sie"); a singular/plural article mismatch ("fill an empty Glossary and Directive fields"). After: both fixed.

Docs — Platform / Locadex

  • platform/locadex/guides/configuring-workflows.mdx: Before: a stray space before a period, and link punctuation placed inside the brackets. After: both fixed.
  • platform/locadex/guides/managing-languages.mdx: Before: link punctuation inside the brackets. After: moved outside, per the docs style guide.
  • platform/locadex/guides/auto-merging-prs.mdx: Before: a comma splice joining two independent clauses inside a parenthetical. After: split with a semicolon and closed the sentence properly.

Docs — Integrations

  • integrations/mintlify/guides/managing-translations.mdx: Before: trailing space in the frontmatter title. After: removed.

How

29 targeted edits across 29 files (docs, blog, devlog, authors). No prose was rewritten for voice/tone, no code semantics were changed, and docs-templates/ was left untouched. A handful of additional findings (frontmatter schema nitpicks, a stacked-callout cleanup) were surfaced by the scan but held back as medium-confidence rather than applied.


Generated by Claude Code

- Remove bare `import Video` statements in 3 devlog entries and 1 blog
  post (CI hard-fails on import/export in MDX body)
- Fix wrong `context` prop -> `$context` in the Next.js quickstart
  troubleshooting section, and `GT_API_KEY` -> `GT_DEV_API_KEY` in two
  Next.js quickstart dev-setup snippets, to match the documented
  config/credentials reference
- Fix a mismatched cross-reference in the React Core linter rules page
  (getGT link pointed at the Node SDK instead of the Next.js function)
- Add missing `occupation` frontmatter field on two author profiles;
  fix a malformed twitter URL on another
- Add missing code-fence language tags, fix link punctuation, drop a
  leftover placeholder anchor and an editorial JSX comment, and other
  small grammar/formatting fixes across docs, blog, and devlog content
@claude

claude Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Automation note (daily-content-docs-scan):

  • Auto-merge could not be enabled: this session's GitHub API access only permits a pinned set of PR-review read operations over GraphQL, and enablePullRequestAutoMerge is a mutation — it's blocked at the proxy. No gh CLI was available as a fallback.
  • The scheduled Slack summary to #C0AEUCELSUT could not be posted: every Slack tool call in this session failed with "this thread's Slack link no longer exists; Slack tools are unavailable for this session," likely because this session's worker process restarted mid-run and lost its Slack binding.

A push notification was sent to the account owner flagging both issues. This PR is otherwise ready for manual review/merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant